package com.shxzz.shortlink.admin.service;

import com.baomidou.mybatisplus.extension.service.IService;
import com.shxzz.shortlink.admin.dao.entity.UserDO;
import com.shxzz.shortlink.admin.dto.req.UserLoginReqDTO;
import com.shxzz.shortlink.admin.dto.req.UserRegisterReqDTO;
import com.shxzz.shortlink.admin.dto.req.UserUpdateReqDTO;
import com.shxzz.shortlink.admin.dto.resp.UserLoginRespDTO;
import com.shxzz.shortlink.admin.dto.resp.UserRespDTO;

/**
 * @author shxzz
 * @create 2023-12-08-18:36
 * @description 用户接口层
 */
public interface UserService extends IService<UserDO> {

    /**
     * 通过 用户名 查询用户
     * @param username 用户名
     * @return 用户响应实体
     */
    UserRespDTO getUserByUserName(String username);

    /**
     * 用户名查询接口
     * @param username 完整用户名
     * @return 存在返回 true，不存在返回 false
     */
    Boolean hasUsername(String username);

    /**
     * 用户注册接口
     * @param requireParam 注册请求参数
     */
    void register(UserRegisterReqDTO requireParam);

    /**
     * 用户登录接口
     * @return 用户登录返回 token
     */
    UserLoginRespDTO login(UserLoginReqDTO requireParam);

    /**
     * 用户信息修改
     * @param requireParam 用户信息修改请求参数 {@link UserUpdateReqDTO}
     */
    void update(UserUpdateReqDTO requireParam);

    /**
     * 用户登出接口
     */
    void logout();

}
